home *** CD-ROM | disk | FTP | other *** search
/ Amiga Collections: Topik / Topik - Disk 18 - Serious (19xx)(Topik Public Domain)(PD)[WB].zip / Topik - Disk 18 - Serious (19xx)(Topik Public Domain)(PD)[WB].adf / Qed / Qed_User.doc < prev    next >
Text File  |  1989-10-01  |  41KB  |  930 lines

  1.  
  2.  
  3.  
  4.  
  5.                                      QED
  6.  
  7.                               AMIGA TEXT EDITOR
  8.                                    REV 1.0
  9.  
  10.                      Copyright 1989 by Darren M. Greenwald
  11.  
  12.                               All rights reserved
  13.  
  14.  
  15.                              User's documentation
  16.                        Last revised 6/18/89  -  QED 0.17
  17.  
  18.      QED may be freely distributed.  It may not be distributed in any
  19. commercial product, shareware product, or commercial publication without
  20. permission.  It is permissible to release QED as part of a public domain
  21. collection, or on a telecommunication service as long as no "special
  22. charge" is made for this program; "special charge" does not include
  23. "reasonable" charges for replication of the media, or standard charges for
  24. use of the system. 
  25.  
  26.      The intent of the above should be clear - I did the work, and while
  27. you are allowed to freely distribute the program, you may not profit from
  28. it.
  29.  
  30.      Any archived files which the author distributes MUST be left intact. 
  31. If you do distribute this program, I insist that you distribute all the
  32. files including any notices.
  33.  
  34.      QED is SHAREWARE - the registration fee is $20, and in return you will
  35. receive complete documentation describing QED's command line language,
  36. ARexx interfacing, keyboard mapping, etc.
  37.  
  38.  
  39.      Darren M. Greenwald
  40.      2511 W. Sunflower Av. #D-16
  41.      Santa Ana, CA 92704
  42.  
  43.      GEnie E-MAIL address: DMG
  44.  
  45.  
  46. DISCLAIMER:
  47. ---------------------------------------------------------------------
  48.  
  49.      In no way can the author be held responsible for any damages, loss of
  50. anticipated profits, or any other perceived loss related to using this
  51. program.  The user assumes the entire risk, and responsibility when using
  52. this program.
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65. Section 1.0                   STARTING QED
  66. =====================================================================
  67.  
  68.      It is assumed the user knows how to install QED on their system, or
  69. working disk.  QED is a stand alone program, and is easily copied to any
  70. destination directory; no special support libraries are required.  A small
  71. utility program called "QGO" is also provided which is needed if QED is
  72. run in its resident mode.
  73.  
  74.      By default, QED opens a single, unnamed text editing window upon
  75. start up.  You may begin entering text immediately if you like, or open an
  76. existing file for editing.  ARexx owners have the option of creating a
  77. start up macro which will be automatically executed when QED is started. 
  78. All of QED's options, and capabilities can be accessed using the macro
  79. capability, so this is an excellent way to create a configuration file to
  80. set the various options up the way that you want.  Only registered users
  81. will receive documentation describing QED's built in command language, and
  82. how to write ARexx macros for use with QED. 
  83.  
  84.  
  85. Section 2.0                QED REQUESTERS
  86. =====================================================================
  87.  
  88.      At times QED will ask for a response from you in the form of a
  89. requester.  All QED requesters are opened in draggable windows, and the
  90. position of all requesters is remembered for the duration of the editing
  91. session.  Therefore you can place the requester windows where you want
  92. them, and they will be opened in the same position where you last left
  93. them.  The size of all requesters are adjusted (width & height) to use your
  94. system font.
  95.  
  96.  
  97.      The File Requester -
  98.      ------------------
  99.  
  100.      Amiga users should be relatively familiar with file requesters,
  101.      however it is worth noting the following:
  102.  
  103.      The QED file requester can display up to 8 files, or sub-directory
  104.      names.  Directory entries are sorted in non-case senstive order, and
  105.      displayed such that sub-directories take precedence over file names.
  106.  
  107.      The QED file requester does not make you wait for the directory to be
  108.      read before you can enter a file name, or change directories.
  109.  
  110.      QED's file requester makes it EASY to select a file, or sub-directory
  111.      name before the entire directory has been read.  First, you can
  112.      enter a new path name, or a file name before the entire directory
  113.      has been read.  Second, QED's file requester does not continually,
  114.      or periodically change the list of names on you until you drag the
  115.      scroll bar.  This means that you can actually single, or double click
  116.      on a name before the entire directory has been read, and not have
  117.      to worry about the list of names changing on you faster then you
  118.      can move the mouse! 
  119.  
  120.      The string gadget labeled "File:" is automatically activated, so it is
  121.      possible in some cases to enter a file name from the keyboard, and
  122.      press the RETURN key without ever touching the mouse.
  123.  
  124.      This file requester dynamically allocates, and deallocates memory as
  125.      needed for the directories; there is no built-in limit on the number
  126.      of directory entries that this requester can handle.
  127.  
  128.      A gadget labeled "TOGGLE:" allows you to toggle between a list of
  129.      devices in your system, and the directory list.  There is no built-in
  130.      limit on the number of devices which this requester can handle, and 
  131.      device names of up to 31 characters in length do not present a problem
  132.      as they do with some requesters.
  133.  
  134.      Input requesters -
  135.      ----------------
  136.  
  137.      Input requesters expect you to respond by typing in a number, or a
  138.      string of text.  Input requesters automatically activate the string
  139.      gadgets so often it is possible to respond by entering the
  140.      number or string(s), and pressing the RETURN key.  Of course you can
  141.      also respond using the mouse to select OK, or CANCEL.  If none of the 
  142.      string gadgets are activated, you can respond with the 'o' or 'c' keys 
  143.      on the keyboard.
  144.  
  145.      Notices & Queries -
  146.      -----------------
  147.  
  148.      Notices can only be responded to with an "OK" response, while queries
  149.      allow you to respond with an "OK" or "CANCEL" response.  If you
  150.      prefer, you can also respond to these requesters using the 'o' or 'c'
  151.      keys on the keyboard
  152.  
  153.  
  154. Section 3.0                   OPENING FILES
  155. =====================================================================
  156.  
  157.      QED allows you to OPEN, or INSERT existing files.  The difference is
  158. that opening a file replaces the text editing buffer, while inserting a
  159. file 'inserts' the file below the cursor position.  When opening a file,
  160. you will be prompted with a requester if you have made any changes to the
  161. text buffer being replaced.
  162.  
  163.      It is also possible to specify one, or more file names to be
  164. automatically opened in separate text editing windows when starting QED
  165. such as:
  166.  
  167. 1> run qed hello.c read_me "df0:my file"
  168.  
  169.      In the above example, QED will attempt to open the files named
  170. "hello.c", "read_me", and "df0:my file" in separate text editing windows. 
  171. If any of the above files are not found, then QED assumes you want to
  172. create a file of the same name, and opens an empty text editing window.
  173.  
  174.      QED is not suitable for use as a binary file editor because some
  175. binary characters are stripped, and converted to other characters when
  176. opening, or inserting a file.
  177.  
  178. Binary value         Action taken
  179. --------------------------------------------------------
  180. 11-255               Valid characters.  No stripping or conversion.
  181.  
  182. 10                   Linefeed - treated as an end of line character.
  183.  
  184. 9                    Tab - If "TAB = SPACES" under the "Options" menu is
  185.                      turned ON, then hard tabs are expanded to spaces
  186.                      when a file is opened, or inserted based upon the
  187.                      windows tab size setting which can be any value from
  188.                      1-8.  If "TAB = SPACES" is OFF (the default setting),
  189.                      then hard tabs are left in a file when opened, or
  190.                      inserted.
  191.  
  192. 1-8                  Valid characters.  No stripping or conversion.
  193.  
  194. 0                    Stripped at load time.
  195.  
  196.  
  197. Selecting "OPEN", or "INSERT" file under the "Project" will result in the
  198. file requester being displayed.
  199.  
  200.  
  201. Section 4.0                   SAVING FILES
  202. =====================================================================
  203.  
  204.      QED allows you to save the entire text editing buffer, or a marked
  205. block of text using the "SAVE AS" option under the "Project" menu.  The
  206. "SAVE AS" option causes the file requester to be displayed.  Named files
  207. can be quickly saved (if any changes have been made to the file) using the
  208. "SAVE" option under the "Project" menu.
  209.  
  210.      In order to save a marked block of text, highlight the block (see the
  211. section described later on how to mark blocks of text), and simply select
  212. "SAVE AS".  When mark block mode is on, it is implied that you want to save
  213. just the marked block of text.  When mark block mode is off, it is implied
  214. that you want to save the entire text editing buffer to a file.
  215.  
  216.      You have the option of creating a backup file under the "Options"
  217. menu.  When turned on, QED will rename any file which is going to be
  218. over-written as 'qed.backup' before saving the file.  This allows you an
  219. opportunity to recover the over-written file should you over-write a file
  220. by mistake.
  221.  
  222.      You also have the option of saving text to a file in append mode under
  223. the "Options" menu.  This capability is often handy when you want to save
  224. multiple blocks of text to a single file.  When this option is turned on,
  225. all text written to a file will be appended to the end of the file.  If the
  226. file does not exist, it will be created.
  227.  
  228.  
  229. Section 5.0                OPENING A NEW WINDOW
  230. =====================================================================
  231.  
  232.      QED supports multiple text editing buffers in the form of an unlimited
  233. number of text editing windows.  This is advantageous because you can see
  234. what each buffer holds, and edit any buffer.  There is no built-in limit
  235. on the number of windows which can be opened other then that which the
  236. operating system can handle, and memory limitations.  There is also no
  237. significant performance penalty for opening multiple windows other then
  238. that which is typical of the operating system when managing multiple
  239. windows on the Workbench screen.
  240.  
  241.      In order to open a new window, select "NEW" under the "Project" menu. 
  242. Note that the pull-down menus are accessable, and shared by all text
  243. editing windows.  It is also important to note that menu selections affect
  244. the window from which the menu item was selected.  For example, selecting
  245. "QUIT" from a window causes only that window to be closed.  When the last
  246. window is closed, QED is automatically terminated.
  247.  
  248.      The general layout of a QED text editing window is depicted by the
  249. diagram below:
  250.  
  251.        ------ File name           -------  Line/Column cursor position
  252.        |                          |
  253. ----------------------------------------------------------
  254. | QED - Untitled              L:     1  C:    20   |  |  |- Front/Back
  255. ----------------------------------------------------------
  256. |                                                      |_|- Top of file
  257. |                                                      |_|- Page up
  258. |                                                        |
  259. |                                                        |
  260. |                      Text editing                      |
  261. |                        work area                       |
  262. |                                                        |
  263. |                                                        |
  264. |                                                       _|
  265. |                                                      |_|-Page down
  266. |                                                      |_|-End of file
  267. |                                                      | |-Window size
  268. ----------------------------------------------------------
  269.  
  270.      You can define the default window size that QED will use to open a
  271. window upon startup, as well as any NEW windows opened via the pull-down
  272. menus.  This capability requires the use of the SETENV function provided as
  273. part of the 1.3 operating system.
  274.  
  275.      In order to use this function, assign ENV: to the RAM: disk, and
  276. use the SETENV command such as -
  277.  
  278. 1>setenv qedsize "0 20 300 100"
  279.  
  280.      Where the four parameters are left edge, top edge, width, and height
  281. in pixels.  If you enter any erroneous arguments, the window is opened to
  282. the full size of the WB screen a few pixels below the title bar.  Ideally
  283. you would make the assignment of the environment variable "qedsize" as part
  284. of your startup-sequence.
  285.  
  286.  
  287.  
  288. Section 6.0                WINDOW OPTIONS
  289. =====================================================================
  290.  
  291.      Each text editing window has its own private text editing buffer, and
  292. private characteristics including:
  293.  
  294.      Under the "Tools" menu
  295.      ----------------------
  296.  
  297.      Pen and paper colors -
  298.  
  299.           Pen, and paper colors can be toggled between 4 preset color
  300.      combinations by selecting "COLOR" under the "Tools" menu.  These
  301.      color combinations have been selected to also work properly using a
  302.      one bit-plane Workbench screen such as is possible using the
  303.      1008x800 monitor.
  304.  
  305.           From the command line mode it is also possible to set a specific
  306.      preset color combination, or any pen/paper color combination of your
  307.      choice.  Pen/Paper colors can be set from 0-255 should newer Amigas
  308.      offer more on-screen colors.
  309.  
  310.  
  311.      Tab size -
  312.  
  313.           The tab size can be set individually from 1-8 for each window
  314.      under the "Tools" menu, but by default is set to the proper value of
  315.      eight (8).  The tab size is used when calculating how many spaces to
  316.      insert when using soft tabs, and affects how hard tabs are displayed.
  317.  
  318.  
  319.      Right margin -
  320.  
  321.           The right margin can be set individually for each window under
  322.      the "Tools" menu.  The right margin setting is used by the formatter,
  323.      and word-wrap routine.  By default, the right margin is set to 75, but
  324.      can be set to any value from 8-10000.
  325.  
  326.           As an alternative, you can set the right margin to a value of one
  327.      (1) in which case the right margin is variable based on window, and
  328.      font width.  In this case the right margin is equivalent to the
  329.      maximum number of columns visible in the window.
  330.  
  331.      Show end of lines -
  332.  
  333.           Selecting "SHOW EOL" under the "Tools" menu toggles visible
  334.      end of line characters on/off.  The actual character used to represent
  335.      end of line characters can be set from the command mode.
  336.  
  337.      Show hard tabs -
  338.  
  339.          Selecting "SHOW TABS" under the "Tools" menu toggles visible
  340.      hard tabs on/off.  The actual character used to represent hard tabs
  341.      can be set from the command mode.
  342.  
  343.      Under the "Options" menu
  344.      ------------------------
  345.  
  346.      Overstrike mode -
  347.  
  348.           QED allows you to enter text in insert, or overstrike mode.
  349.  
  350.      Word wrap -
  351.  
  352.           QED will perform "simple" word-wrap when text is entered past the
  353.      right margin.  This feature should not be confused with the more
  354.      complex real-time paragraph reformatters typical of many word-
  355.      processors.
  356.  
  357.      Case sensitive search mode -
  358.  
  359.           QED allows you to search for text in case, or non-case sensitive
  360.      search modes.  When case sensitive mode is turned off, the alpha
  361.      characters (a-z and A-Z) are treated as equivalent.
  362.  
  363.           For example, you could enter "cat" as a search string, and
  364.      "cat", "CAT", "Cat", etc., would all be found when searching for
  365.      text, and/or when searching & replacing text.
  366.  
  367.      Append saves -
  368.  
  369.           This option allows you to save text to a file in append mode in
  370.      which case any text written to an existing file will be appended to
  371.      the end of the file.  This capability is often useful when marking
  372.      multiple blocks of text to be saved to single a file.
  373.  
  374.      Backup files -
  375.  
  376.           This option will cause any file which is going to be over-written
  377.      by a save operation to be renamed as "qed.backup" before saving the
  378.      file.  This allows you an opportunity to recover a file which is
  379.      inadvertently replaced by a save operation.  
  380.  
  381.      Mark line mode -
  382.  
  383.           When this option is turned on, you can only mark whole lines
  384.      of text to be cut, copied, saved, erased, formatted, replaced,
  385.      and printed.  The block, and project insert functions are also
  386.      affected.  When this options is turned on, a block of text which is
  387.      inserted from the clipboard, or a file will be inserted as a group of
  388.      lines above the cursor position.  This mode will most likely be
  389.      preferred by those working with line oriented text (e.g., programmers).
  390.  
  391.           When this option is turned off, you can mark a block of text
  392.      from any line/column position to any line/column position.  The block,
  393.      and project insert functions are also affected.  When this option is
  394.      turned off, a block of text which is inserted from the clipboard, or a
  395.      file will be inserted at the cursor position.  This mode will most
  396.      likely be preferred by those working with document oriented text.
  397.  
  398.  
  399.      Free form editing -
  400.  
  401.           This option affects the cursor's behavior.  When turned on, the
  402.      cursor can be positioned past the end of line allowing you to enter
  403.      text beyond the end of a line in which case spaces are automatically
  404.      inserted as needed.  This mode will most likely be preferred by those
  405.      working with line oriented text (e.g., programmers).
  406.  
  407.           When turned off, the cursor cannot be moved past the end of line.
  408.      The right cursor key is also affected; if you cursor right past the
  409.      end of a line, the cursor is wrapped to the first character of the
  410.      next line.  This mode will most likely be preferred by those working
  411.      with document oriented text.
  412.  
  413.      Insert tabs -
  414.  
  415.           This option affects how the TAB key behaves.  When turned off,
  416.      the tab key moves the cursor to the next tab stop.  When turned on,
  417.      the TAB key can be used to insert hard tabs, or an equivalent number
  418.      of spaces (see "Tabs equal to spaces" below).
  419.  
  420.      Tabs equal to spaces -
  421.  
  422.           This option affects how the TAB key behaves.  When turned on,
  423.      soft tabs (spaces) are used instead of hard tabs (binary 9).  This
  424.      option is checked for when you press the TAB key, when indenting
  425.      lines, and when a file is opened, or inserted (allowing you to de-tab
  426.      files at load time).
  427.  
  428.      When opening a new window, these characterstics are inherited from the
  429. window from which the "NEW" command was issued.  It is also possible to
  430. write macros which are automatically executed when a file is opened.  This
  431. capability is extremely useful for automatically adjusting the various
  432. window options listed above to suit the type of file you are working on.
  433.  
  434. For example, you might load a "C" source code file in one window, and have
  435. a macro which automatically sets your tab size to three (3), turns mark
  436. line mode on, turns free-form editing on, etc.
  437.  
  438. In another window you might then load a document file, and have a macro
  439. which automatically sets your tab size to five (5), turns mark line mode
  440. off, turns free-form editing off, etc.
  441.  
  442.  
  443. Section 7.0                CURSOR POSITIONING
  444. =====================================================================
  445.  
  446.      Like most text editors, QED allows you to insert, or over-strike text
  447. at the cursor position.  Perhaps the easiest way to position the cursor is
  448. with the mouse using the "point & click" method.  Of course the keyboard
  449. can be used to position the cursor using the cursor keys.
  450.  
  451.      Text scrolling is allowed in all directions, and can be accomplished
  452. via the cursor keys, or mouse using the "point & drag" method.
  453.  
  454.      It is also possible to go to a specific line number (see the "Cursor"
  455. menu), or mark & go to a spot.  Command line mode users have many more
  456. cursor positioning tools available such as the ability to go to a specific
  457. line, and column position.
  458.  
  459.  
  460. Cursor key   |  Result
  461. ---------------------------------------------------------------------------
  462.              |
  463. Up           | Move the cursor up a single line.
  464.              |
  465. Down         | Move the cursor down a single line.
  466.              |
  467. Left         | Move the cursor left a single character.  If the cursor is
  468.              | at the beginning of a line, the cursor is wrapped up to the
  469.              | end of the previous line.
  470.              |
  471. Right        | Move the cursor right a single character.
  472.              |
  473. SHIFTED      | Move the cursor up a single window page.
  474. Up           |
  475.              |
  476. SHIFTED      | Move the cursor down a single window page.
  477. Down         |
  478.              |
  479. SHIFTED      | Move the cursor to the previous word.
  480. Left         |
  481.              |
  482. SHIFTED      | Move the cursor to the next word.
  483. Right        |
  484.              |
  485. ALT          | Move the cursor to the first line in the text editing
  486. Up           | buffer.
  487.              |
  488. ALT          | Move the cursor to the last line in the text editing buffer.
  489. Down         |
  490.              |
  491. ALT          | Move the cursor to the beginning of the line.
  492. Left         |
  493.              |
  494. ALT          | Move the cursor to the end of the line.
  495. Right        |
  496.              |
  497. CTRL         | Move the cursor to the top of the window.
  498. Up           |
  499.              |
  500. CTRL         | Move the cursor to the bottom of the window.
  501. Left         |
  502. ---------------------------------------------------------------------------
  503.  
  504.  
  505. Section 8.0                BASIC EDITING KEYS
  506. =====================================================================
  507.  
  508.  
  509. Keypress     |   Result
  510. ---------------------------------------------------------------------------
  511.              |
  512. RETURN       | Splits the line at the cursor position.  If the cursor
  513.              | is positioned beyond the end of the line, a new line is 
  514.              | inserted.
  515.              |
  516. ENTER        | Inserts a new line with AUTO-INDENT.
  517.              |
  518. DELETE       | Deletes the character under the cursor.
  519.              |
  520. BACKSPACE    | Deletes the character to the left of the cursor.  If the 
  521.              | cursor is on the beginning of a line, the BACKSPACE key
  522.              | can be used to join the line with the previous line by
  523.              | effectively deleting the previous end-of-line character.
  524.              |
  525. TAB          | Moves the cursor to the next tab stop.  The tab size by 
  526.              | default is set to the proper tab value of 8, but can be
  527.              | set individually for each window.  You also have the option
  528.              | under the "Options" menu of having the tab key insert a
  529.              | sufficient number of spaces at the cursor position to move
  530.              | the cursor to the next tab stop, or to insert a hard tab.
  531.              |
  532. ---------------------------------------------------------------------------
  533.  
  534.  
  535. Section 9.0                DELETING TEXT
  536. =====================================================================
  537.  
  538.      At times you may want to delete larger pieces of text then is
  539. practical using the BACKSPACE, and DELETE keys described above.  QED
  540. provides a number of tools for deleting text listed under the "Edit" menu.
  541.  
  542.      Delete line -
  543.  
  544.           The entire line on which the cursor resides is deleted.
  545.  
  546.      Delete to end of line -
  547.  
  548.           Deletes all text from the cursor position to the end of the line.
  549.  
  550.      Delete word -
  551.  
  552.           Deletes the word on which the cursor resides.
  553.  
  554.      Undelete -
  555.  
  556.           Text which has been deleted using any of the above 3 functions is
  557.      copied to a 256 byte private backup buffer (one buffer per editing
  558.      window).  The last bit of deleted text (line, word, or end of line)
  559.      can be restored using the undelete command.
  560.  
  561.           QED will allow you to work with lines longer then 256 characters,
  562.      however to insure that you have an opportunity to undelete text, the
  563.      delete tools listed above will not work if the amount of text to be
  564.      deleted exceeds 256 characters.  In this case use the block cut, or
  565.      erase commands.
  566.  
  567.  
  568. Section 10.0                BLOCK OPERATIONS
  569. =====================================================================
  570.  
  571.      QED allows you to mark a block of text to be cut, or copied to a
  572. clipboard area which is used by all the text editing windows.  In addition,
  573. many of the QED commands can be restricted to a marked block of text (e.g.,
  574. SAVE AS, REPLACE, PRINT, FORMAT, etc.).
  575.  
  576.      Mark block mode can be toggled on/off from the pull-down menus under
  577. the "Edit" menu, or can be toggled on/off by "double-clicking" the left
  578. mouse button over the same row/column position.
  579.  
  580.      Mark block mode is transparent; you can continue to edit text like
  581. usual, and the pull-down menus are always accessable.  In order to mark a
  582. block of text, simply toggle mark block mode on, and use the cursor keys,
  583. or mouse to highlight a range of text.
  584.  
  585.      As indicated above, you have the option under the "Options" menu of
  586. toggling between line mark mode (always marks whole lines), or free mark
  587. mode (allows you to mark from/to any row/column position).
  588.  
  589.      Both the CUT, and COPY block tools under the "Edit" menu copy
  590. the marked block of text to the clipboard, however CUT block also deletes
  591. the text.
  592.  
  593.      In some cases you may want to cut a block of text, but you don't
  594. want it copied to the clipboard.  In this case use the ERASE tool under the
  595. "Project" menu.  ERASE will erase all text in a text editing window, and
  596. free any up any memory that it can, however if mark block mode is on, the
  597. ERASE function will only erase the marked block.  In either case you will
  598. be prompted with a requester because any erased text cannot be restored.
  599.  
  600.      INSERT block under the "Edit" menu inserts whatever is in the clipboard
  601. at the cursor position.  If MARK LINE MODE is ON, the contents of clipboard
  602. will be inserted as a group of lines above the cursor position.  If MARK
  603. LINE MODE is OFF, the contents of the clipboard will be inserted at the
  604. cursor position.
  605.  
  606.  
  607. Section 11.0                SEARCH & REPLACE
  608. =====================================================================
  609.  
  610.      The SEARCH, REPLACE, and HUNT tools under the "Tools" menu allow you
  611. to search for a phrase, replace a phrase, and quickly repeat the last
  612. search and/or replace operation.
  613.  
  614.      As indicated above, QED supports both case, and non-case sensitive
  615. search modes, and can be optionally set for each text editing window.
  616.  
  617.      Both SEARCH, and REPLACE will prompt you for strings using a
  618. requester.  Both commands will search forward from the cursor position for
  619. a matching search string, and position the cursor on the first occurrance
  620. of the search string if a match was found.
  621.  
  622.      When using the REPLACE command, you will also be prompted with a
  623. message in the title bar of the window such as:
  624.  
  625.      Replace? (Y)es (N)o (G)lobal (M)arked (Q)uit
  626.  
  627.      You may respond using the upper, or lower case keys on the keyboard
  628.      where (?) causes the following action to be taken:
  629.  
  630.      (Y)es    - Yes, replace the string with the search string, and
  631.                 continue searching.
  632.  
  633.      (N)o     - No, don't replace the string, and continue searching.
  634.  
  635.      (G)lobal - Replace all occurrences of the search string forward from
  636.                 the cursor position.
  637.  
  638.      (M)arked - Replace all occurrences of the search string found within
  639.                 a marked block.  In order to use this option, you must
  640.                 first mark a block of text.
  641.  
  642.      (Q)uit   - Quit searching.  You may also click in the window with
  643.                 the LEFT mouse button to abort the search.
  644.  
  645.      In order to search, and replace on 'end-of-line' characters, simply
  646. use the CTRL-J character in your search, and replace strings to denote
  647. 'end-of-line' characters.  CTRL-J is equivalent to a binary value of 10;
  648. also known as a LINEFEED.  Other control key sequences as listed in Section
  649. 16.0 below may also be used in your search strings as needed.
  650.  
  651.      The HUNT command can be used to repeat the last SEARCH, and/or REPLACE
  652. operation.  When using the HUNT command, searches will skip the character
  653. under the cursor to avoid finding duplicate matches of a string.
  654.  
  655.      
  656. Section 12.0                FORMATTING TEXT
  657. =====================================================================
  658.  
  659.      The FORMAT tool under the "Tools" menu allows you to format a
  660. paragraph, or a marked block of text.
  661.  
  662.      If mark block mode is off, then FORMAT searches forward from the line
  663. on which the cursor resides for two (2) consecutive end of line characters.
  664.  The following illustration may be helpful in better understand how the
  665. FORMAT tool works.
  666.  
  667. Let's suppose the original piece of text looks like this:
  668. --------------------------------------------------------
  669.  
  670. This is some text to demonstrate a point.
  671.  
  672. This is some more text.
  673.  
  674.  
  675. This is how the text is evaluated by the FORMAT command:
  676. -------------------------------------------------------
  677.            _________________________________Cursor position column 11.
  678.           |
  679.           |          _______________________Wrapping will occur here.
  680.           |         |
  681.           |         |    ___________________Right margin is 25.
  682.           |         |   |
  683.           |         |   |        ___________Column 33 is > right margin.
  684.           |         |   |       |
  685. This is some text to demonstrate a point. - This line of text is terminated
  686.                                           - by 2 end-of-line characters.
  687. This is some more text
  688.  
  689.  
  690. This is the result after using the FORMAT command:
  691. -------------------------------------------------
  692.  
  693. This is some text to
  694. demonstrate a point.
  695.  
  696. This is some more text.
  697.  
  698.  
  699.      FORMAT will never insert, or delete any spaces.  What it will do is
  700. replace spaces with end-of-line characters, and vice-versa in an attempt to
  701. cause the affected text to fit in the right margin setting with word-wrap.
  702.  
  703.  
  704. Section 13.0                INDENTING TEXT
  705. =====================================================================
  706.  
  707.      Programmers who work with block oriented languages frequently find
  708. themselves indenting sections of source code left, and right.  Often this
  709. can mean manually deleting, and/or inserting spaces or tabs.  QED provides
  710. a tool which allows you to easily indent a line, or a range of lines to the
  711. next left or right tab position.
  712.  
  713.      Under the "Tools" menu, you have the option of indenting the current
  714. line left, or right to the next tab stop, or indenting multiple lines.  If
  715. you choose the INDENT MULTIPLE tool, you will be prompted with a message in
  716. the window's title bar such as:
  717.  
  718.      Indent? (R)ight (L)eft (S)kip ([) (]) (Q)uit
  719.  
  720.      You may respond using the upper, or lower case keys on the keyboard
  721.      where (?) causes the following action to be taken:
  722.  
  723.      (R)ight - Indent line right, and move cursor to the next line.
  724.  
  725.      (L)eft  - Indent line left, and move cursor to the next line.
  726.  
  727.      (S)kip  - Skip the line, and move cursor to the next line.
  728.  
  729.      ([)     - Indent line left, and don't move the cursor.
  730.  
  731.      (])     - Indent line right, and don't move the cursor.
  732.  
  733.      (Q)uit  - Abort multiple indent utility.  You may also click in the
  734.                window with the LEFT mouse button to quit.
  735.  
  736.  
  737. The INDENT MULTIPLE tool is extremely useful when you wish to change the
  738. indent of a range of lines.  Place the cursor at the top line of the range
  739. you want to change, and repeatedly use the (R), or (L) keys.  You can also
  740. skip lines you dont want changed, and adjust each line individually using
  741. the ([), and (]) keys.
  742.  
  743. You have the option of indenting lines using hard tabs, or soft tabs
  744. (spaces).  If "TAB = SPACES" is turned ON under the "Options" menu, soft
  745. tabs will be used when indenting lines.  If "TAB = SPACES" is turned OFF,
  746. then hard tabs will be used.
  747.  
  748.  
  749. Section 14.0             MISCELLANEOUS FEATURES
  750. =====================================================================
  751.  
  752.      QED allows you to assign any built in QED command, ARexx macro, and
  753. any DOS command to ANY key when pressed alone (including the FUNCTION
  754. keys), or to ANY key when pressed in conjunction with the CTRL, ALT, or
  755. SHIFT keys.  In order to use this capability you will need the Registered
  756. User's Documentation.
  757.  
  758.      By default the ALT/keys are mapped to imitate the RIGHT AMIGA key menu
  759. alternatives listed in the pull-down menus.  For those of you who are
  760. uncomfortable with using the RIGHT AMIGA key, you can use the LEFT, or
  761. RIGHT ALT key instead unless you reassign these keys.
  762.  
  763.      Even though there is no "NEW CLI" command in the pull-down menus, the
  764. CTRL/HELP key combination is by default mapped to open a new CLI window.
  765.  
  766.      If you own Brian Jackson's ACK terminal program for the Amiga, you can
  767. mark blocks of text to be sent to ACK via a message port just as if you had
  768. typed the text directly, or sent an ASCII file.  In order to do this,
  769. simply mark a block of text that you want to send, and press CTRL "`". 
  770. Remember that if this does not suit your taste, you can remap the keyboard
  771. as mentioned above.  Only the Amiga makes it possible!
  772.  
  773.      Brian Jackson can be reached on GEnie: E-MAIL address "B.J."
  774.  
  775.      The ERASE function under the "Project" menu will clear, and reset the
  776. text editing buffer as described under section 10.0 above.
  777.  
  778.      The JOIN command under the "Edit" menu will join the line on which the
  779. cursor resides with the previous line.  Joining lines can also be
  780. accomplished by back spacing over the previous end of line character as
  781. described under section 8.0 above.
  782.  
  783.      The MARK SPOT, and GOTO SPOT commands under the "Edit" menu can be
  784. used to mark spot, and quickly return to the same position later, however
  785. the spot may be lost when using the global replace capabilities, or if you
  786. delete the text corresponding to the marked spot.
  787.  
  788.      QED has a built-in keyboard repeat limiting feature which will only
  789. limit repeating key press messages if QED cannot keep up (e.g., during
  790. heavy multi-tasking, or when working with very large files).  If you have
  791. ever used an Amiga program in which you inadvertently held down a repeating
  792. key such as the BACKSPACE key too long, and watched your last 10 minutes of
  793. work be erased, you will appreciate this feature.
  794.  
  795.      You can quickly move between multiple windows opened with the NEW
  796. command by using the "NEXT", and "PREV" items under the "Project" menu.  If
  797. you have more then one window open, these two items will bring the next, or
  798. previous window to front, and activate it as if you had clicked in it with
  799. the mouse. 
  800.  
  801.  
  802. Section 15.0         THE COMMAND LINE MODE & AREXX MACROS
  803. =====================================================================
  804.  
  805.      The "CMD LINE" command under the "Tools" menu causes the command line
  806. window to be opened (if its not already), and assigns the command line
  807. window to the text editing window from which this command was issued.  As
  808. an alternative, you can use the ESC key.  The command line mode allows you
  809. to enter commands, and execute/debug ARexx macros.  Any command which can
  810. be performed using the pull-down menus, or keyboard can be accomplished
  811. from the command line mode, and much more...
  812.  
  813.      The command line mode allows you to perform all of the functions
  814. available in the pull-down menus, execute ARexx macros, and more.  In order
  815. to use this capability you will need the Registered User's Documentation.
  816.  
  817.      The "RUN MACRO" command under the "Tools" menu will list, and allow you
  818. to execute all ARexx macros in your REXX: directory.
  819.  
  820.  
  821. Section 16.0            EDITING BINARY CHARACTERS
  822. =====================================================================
  823.  
  824.      QED is a text editor, so binary file editing is not fully supported,
  825. however you can open, display, edit, and save most of the binary character
  826. set other then binary 0.  This capability should provide sufficient for
  827. those who would like to insert ANSI, or printer device control sequences in
  828. their files.
  829.  
  830.      QED utilizes your system font, and it is worth noting that AMIGA fonts
  831. generally do not contain character definitions for the complete binary
  832. character set 0-255.  Most system fonts only have character imagery for
  833. binary 32-255, and possibly a smaller subset of characters.  Undefined
  834. characters are displayed using a default image (generally a box).
  835.  
  836.      In order to compensate, QED will display the characters "A" through
  837. "_" in inverted imagery to represent binary 1-31.
  838.  
  839.      You can also enter these characters from the keyboard by holding down
  840. the CTRL key, and pressing the following keys on the keyboard:
  841.  
  842.      a = binary 1                  q = binary 17
  843.      b = binary 2                  r = binary 18
  844.      c = binary 3                  s = binary 19
  845.      d = binary 4                  t = binary 20
  846.      e = binary 5                  u = binary 21
  847.      f = binary 6                  v = binary 22
  848.      g = binary 7                  w = binary 23
  849.      h = binary 8                  x = binary 24
  850.      i = binary 9  (Hard tab)      y = binary 25
  851.      j = binary 10 (Line feed)     z = binary 26
  852.      k = binary 11                 [ = binary 27
  853.      l = binary 12                 \ = binary 28
  854.      m = binary 13 (Cairrage ret)  ] = binary 29
  855.      n = binary 14                 ^ = binary 30 (CTRL SHIFTED 6)
  856.      o = binary 15                 _ = binary 31 (CTRL SHIFTED -)
  857.      p = binary 16
  858.  
  859.      The above sequences rely on the standard operating system routines to
  860. decode the keyboard, however you can assign key values to any keyboard
  861. combination of your choice from the command mode.  Of course you can also
  862. assign whole strings of text which may include binary control sequences to
  863. a key press combination.
  864.  
  865.  
  866. Section 17.0                  PRINTING
  867. =====================================================================
  868.  
  869.      QED allows you to print the entire contents of a windows text editing
  870. buffer, or a marked block of text (if a block is marked).  Simply select
  871. PRINT from the pull down menus, and respond to the requester verifying that
  872. you want to print.  Printing occurs as a background task, and does not
  873. interfere with any other QED features.  You may even quit QED while
  874. printing is still in process.  In this case QED will release as much
  875. memory as it can, and will hang around in a wait state until the printer is
  876. done before fully exiting.
  877.  
  878.      If you select PRINT again while the printer is busy, you will be
  879. prompted with a requester asking if you want to cancel the current print
  880. job.  If you elect to cancel printing, the printer will stop as soon as
  881. possible.  This may take a few seconds for the printer.device to abort.
  882.  
  883.  
  884. Section 18.0             MAKING QED RESIDENT
  885. =====================================================================
  886.  
  887.      QED can be started in "resident" mode by including "-r" (no quotes) as
  888. the first argument on the command line.  This mode will force QED to hang
  889. around in memory until awakened by another small utility program provided
  890. with QED.
  891.  
  892.      Normally when you load QED from disk, or from ram disk, QED will exit
  893. when the last text editing window is closed freeing up all the memory used
  894. by QED.  If you run, and exit QED frequently, this means that QED must be
  895. reloaded each time.  Many users place commonly used programs in a ram disk;
  896. this avoids the delays of reloading a program from floppy, or hard drive,
  897. but still means that the program must be copied from ram disk to another
  898. section of memory before being run.
  899.  
  900.      QED's resident mode allows you to keep a "single" copy of QED hanging
  901. around in memory at all times.  This is more efficient then run QED from a
  902. ram disk, and faster then reloading QED from a floppy, or hard drive.
  903.  
  904.      Remember that QED allows you to open an unlimited number of text
  905. editing windows, that there is no significant performance penalty for
  906. opening multiple windows, and that this is much more efficient then running
  907. multiple copies of QED to edit separate files.  You can still run QED as
  908. separate tasks if desired, however only one copy of QED can be made
  909. resident, and in most cases one copy of QED is sufficient to handle your
  910. multi-file editing needs.  
  911.  
  912.      If QED is started in resident mode using the "-r" flag, by default no
  913. text editing windows, or files will be opened.  You can still include a
  914. list of file names following this command line flag to be automatically
  915. loaded into separate text editing windows.  See section 3.0 for details on
  916. specifying a list of files to be opened as CLI arguments.
  917.  
  918.      A small utility program has been provided called "QGO" which will send
  919. the necessary commands to a resident QED task to open new QED windows,
  920. files, etc.  In fact "QGO" behaves much like QED in that you can specify a
  921. list of files names to be automatically opened in separate text editing
  922. windows.  If no file names are included as CLI arguments, "QGO" will send
  923. the necessary commands to QED to open a single, un-named text editing
  924. window.
  925.  
  926.      Finally "QGO" can also send a command to QED to turn resident mode
  927. off, in which case QED will be fully exited once the last window is closed.
  928.  In order to do this, simple include "-q" as the first CLI argument when
  929. using the "QGO" program.
  930.